Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
SshServerProcess Class Reference

SshServerProcess handles and manipulates the SSH service. More...

Inheritance diagram for SshServerProcess:
TelnetServerProcess Process

Public Member Functions

void setVersion (Ssh::SshVersion)
 Sets the SSH version. More...
 
Ssh::SshVersion getVersion ()
 Returns the SSH version. More...
 
bool isUsernameReceived ()
 Returns true if the username is received, otherwise false. More...
 
void usernameReceived (bool)
 Sets the username as received or not received. More...
 
void setRetryAmount (int)
 Sets the retry amount. More...
 
int getRetryAmount ()
 Returns the retry amount. More...
 
void setAuthTimeout (int)
 Sets the authentication timeout. More...
 
int getAuthTimeout ()
 Returns the authentication timeout. More...
 
- Public Member Functions inherited from TelnetServerProcess
int getTelnetClientCount ()
 Returns the number of telnet clients connected. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

SshServerProcess handles and manipulates the SSH service.

Member Function Documentation

◆ getAuthTimeout()

int SshServerProcess::getAuthTimeout ( )

Returns the authentication timeout.

Parameters
int,theauthentication timeout.

◆ getRetryAmount()

int SshServerProcess::getRetryAmount ( )

Returns the retry amount.

Returns
int, the retry amount.

◆ getVersion()

Ssh::SshVersion SshServerProcess::getVersion ( )

Returns the SSH version.

Returns
enum<Ssh::SshVersion>, the SSH version. SSH versions: shVerDefault = 0, sshVerOne = 1, sshVerTwo = 2

◆ isUsernameReceived()

bool SshServerProcess::isUsernameReceived ( )

Returns true if the username is received, otherwise false.

Returns
bool, true if the username is received, otherwise false.

◆ setAuthTimeout()

void SshServerProcess::setAuthTimeout ( int  )

Sets the authentication timeout.

Parameters
sec,theauthentication timeout.

◆ setRetryAmount()

void SshServerProcess::setRetryAmount ( int  )

Sets the retry amount.

Parameters
amt,theretry amount.

◆ setVersion()

void SshServerProcess::setVersion ( Ssh::SshVersion  )

Sets the SSH version.

Parameters
version,theSSH version. SSH versions: shVerDefault = 0, sshVerOne = 1, sshVerTwo = 2

◆ usernameReceived()

void SshServerProcess::usernameReceived ( bool  )

Sets the username as received or not received.

Parameters
usernameReceived,truefor received, false for not received.

The documentation for this class was generated from the following file: